<?php
/**
 *  NevuxBB - Free Forum Software
 *  Copyright (C) 2008, 2010 NevuxBB (No one specific author)*  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * String Function
 * File: excerpt_string.php
 * Purpose: To summarise text
 *
 */

// truncate/excert/summarise text
function excerpt_text($text, $length = 10, $end = '...') {
	// minus the equation for the ending
	$length -= mb_strlen($end);
	
	// is the string longer than length ?
	if(mb_strlen($text) > $length) {
		// text is longer than length, cut it down
		return mb_substr($text, 0, $length) . $end;
	} else {
		// text is short enough, just return it
		$final = $text;
	}
	
	// return the text
	return $final;
}


?>